<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/channel.hpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_0c017496b493ff066fbbe686970307ba.html">transport</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">channel.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="sync__io_2native__socket__stream_8hpp_source.html">ipc/transport/sync_io/native_socket_stream.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="native__socket__stream_8hpp_source.html">ipc/transport/native_socket_stream.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="sync__io_2blob__stream__mq__snd_8hpp_source.html">ipc/transport/sync_io/blob_stream_mq_snd.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="blob__stream__mq__snd_8hpp_source.html">ipc/transport/blob_stream_mq_snd.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="sync__io_2blob__stream__mq__rcv_8hpp_source.html">ipc/transport/sync_io/blob_stream_mq_rcv.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="blob__stream__mq__rcv_8hpp_source.html">ipc/transport/blob_stream_mq_rcv.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ipc__core_2src_2ipc_2transport_2error_8hpp_source.html">ipc/transport/error.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="transport__fwd_8hpp_source.html">ipc/transport/transport_fwd.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="process__credentials_8hpp_source.html">ipc/util/process_credentials.hpp</a>&quot;</code><br />
</div>
<p><a href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Channel.html">ipc::transport::Channel&lt; Blob_sender, Blob_receiver, Native_handle_sender, Native_handle_receiver &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Peer to a bundle of 1-2 full-duplex pipe(s), one for transmitting unstructured binary blobs; the other for transmitting native handle+blob combos; hence a <a class="el" href="classipc_1_1transport_1_1Blob__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">Blob_sender</a> + <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a>, a <a class="el" href="classipc_1_1transport_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">Native_handle_sender</a> + <a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Native_handle_receiver</a>, or both.  <a href="classipc_1_1transport_1_1Channel.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Null__peer.html">ipc::transport::Null_peer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dummy type for use as a template param to <a class="el" href="classipc_1_1transport_1_1Channel.html" title="Peer to a bundle of 1-2 full-duplex pipe(s), one for transmitting unstructured binary blobs; the othe...">Channel</a> when either the blobs pipe or handles pipe is disabled; as well as to mark a given peer object as not having a counterpart form: a <code><a class="el" href="namespaceipc_1_1transport_1_1sync__io.html" title="sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.">sync_io</a></code> object shall have its <code>using Sync_io_obj = <a class="el" href="classipc_1_1transport_1_1Null__peer.html" title="Dummy type for use as a template param to Channel when either the blobs pipe or handles pipe is disab...">Null_peer</a></code> and coversely for async-I/O guys and their <code>Async_io_obj</code>s.  <a href="classipc_1_1transport_1_1Null__peer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Socket__stream__channel.html">ipc::transport::Socket_stream_channel&lt; SIO &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="classipc_1_1transport_1_1Channel.html" title="Peer to a bundle of 1-2 full-duplex pipe(s), one for transmitting unstructured binary blobs; the othe...">Channel</a> with a <em>handles pipe</em> only (no <em>blobs pipe</em>) that uses a Unix domain socket connection as the underlying transport for that pipe.  <a href="classipc_1_1transport_1_1Socket__stream__channel.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Socket__stream__channel__of__blobs.html">ipc::transport::Socket_stream_channel_of_blobs&lt; SIO &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="classipc_1_1transport_1_1Channel.html" title="Peer to a bundle of 1-2 full-duplex pipe(s), one for transmitting unstructured binary blobs; the othe...">Channel</a> with a <em>blobs pipe</em> only (no <em>handles pipe</em>) that uses a Unix domain socket connection as the underlying transport for that pipe.  <a href="classipc_1_1transport_1_1Socket__stream__channel__of__blobs.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Mqs__channel.html">ipc::transport::Mqs_channel&lt; SIO, Persistent_mq_handle, Native_handle_sender, Native_handle_receiver &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="classipc_1_1transport_1_1Channel.html" title="Peer to a bundle of 1-2 full-duplex pipe(s), one for transmitting unstructured binary blobs; the othe...">Channel</a> with <em>at least</em> a <em>blobs pipe</em> consisting of two MQs of type <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html" title="A documentation-only concept defining the behavior of an object representing a light-weight handle to...">Persistent_mq_handle</a> (template arg 1); and <em>possibly</em> a <em>handles pipe</em> as governed by template args 2 and 3 which default to <a class="el" href="classipc_1_1transport_1_1Null__peer.html" title="Dummy type for use as a template param to Channel when either the blobs pipe or handles pipe is disab...">Null_peer</a> (in which case the handles pipe is disabled).  <a href="classipc_1_1transport_1_1Mqs__channel.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Mqs__socket__stream__channel.html">ipc::transport::Mqs_socket_stream_channel&lt; SIO, Persistent_mq_handle &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="classipc_1_1transport_1_1Channel.html" title="Peer to a bundle of 1-2 full-duplex pipe(s), one for transmitting unstructured binary blobs; the othe...">Channel</a> with a <em>blobs pipe</em> consisting of 2 MQs of type <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html" title="A documentation-only concept defining the behavior of an object representing a light-weight handle to...">Persistent_mq_handle</a> (template arg); and a <em>handles pipe</em> over a Unix domain socket connection.  <a href="classipc_1_1transport_1_1Mqs__socket__stream__channel.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceipc"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc.html">ipc</a></td></tr>
<tr class="memdesc:namespaceipc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Catch-all namespace for the Flow-IPC project: A library/API in modern C++17 providing high-performance communication between processes. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceipc_1_1transport"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport.html">ipc::transport</a></td></tr>
<tr class="memdesc:namespaceipc_1_1transport"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) between pairs of processes. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a5dfdd05a68a4cee245ca6f3393a090b1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ipc__core_2src_2ipc_2transport_2channel_8hpp.html#a5dfdd05a68a4cee245ca6f3393a090b1">TEMPLATE_CHANNEL</a>&#160;&#160;&#160;  template&lt;typename Blob_sender, typename Blob_receiver, typename Native_handle_sender, typename Native_handle_receiver&gt;</td></tr>
<tr class="memdesc:a5dfdd05a68a4cee245ca6f3393a090b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>).  <a href="ipc__core_2src_2ipc_2transport_2channel_8hpp.html#a5dfdd05a68a4cee245ca6f3393a090b1">More...</a><br /></td></tr>
<tr class="separator:a5dfdd05a68a4cee245ca6f3393a090b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa498064773ba3aad9a5828df463739a7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ipc__core_2src_2ipc_2transport_2channel_8hpp.html#aa498064773ba3aad9a5828df463739a7">CLASS_CHANNEL</a>&#160;&#160;&#160;  Channel&lt;Blob_sender, Blob_receiver, Native_handle_sender, Native_handle_receiver&gt;</td></tr>
<tr class="memdesc:aa498064773ba3aad9a5828df463739a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>).  <a href="ipc__core_2src_2ipc_2transport_2channel_8hpp.html#aa498064773ba3aad9a5828df463739a7">More...</a><br /></td></tr>
<tr class="separator:aa498064773ba3aad9a5828df463739a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8eff22e594b6fe82f94f13d6a172537f"><td class="memTemplParams" colspan="2">template&lt;typename Blob_sender , typename Blob_receiver , typename Native_handle_sender , typename Native_handle_receiver &gt; </td></tr>
<tr class="memitem:a8eff22e594b6fe82f94f13d6a172537f"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport.html#a8eff22e594b6fe82f94f13d6a172537f">ipc::transport::operator&lt;&lt;</a> (std::ostream &amp;os, const Channel&lt; Blob_sender, Blob_receiver, Native_handle_sender, Native_handle_receiver &gt; &amp;val)</td></tr>
<tr class="memdesc:a8eff22e594b6fe82f94f13d6a172537f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code><a class="el" href="classipc_1_1transport_1_1Channel.html" title="Peer to a bundle of 1-2 full-duplex pipe(s), one for transmitting unstructured binary blobs; the othe...">Channel</a></code> to the given <code>ostream</code>.  <a href="namespaceipc_1_1transport.html#a8eff22e594b6fe82f94f13d6a172537f">More...</a><br /></td></tr>
<tr class="separator:a8eff22e594b6fe82f94f13d6a172537f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aa498064773ba3aad9a5828df463739a7" name="aa498064773ba3aad9a5828df463739a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa498064773ba3aad9a5828df463739a7">&#9670;&nbsp;</a></span>CLASS_CHANNEL</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CLASS_CHANNEL&#160;&#160;&#160;  Channel&lt;Blob_sender, Blob_receiver, Native_handle_sender, Native_handle_receiver&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>). </p>

<p class="definition">Definition at line <a class="el" href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html#l01347">1347</a> of file <a class="el" href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html">channel.hpp</a>.</p>

</div>
</div>
<a id="a5dfdd05a68a4cee245ca6f3393a090b1" name="a5dfdd05a68a4cee245ca6f3393a090b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dfdd05a68a4cee245ca6f3393a090b1">&#9670;&nbsp;</a></span>TEMPLATE_CHANNEL</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TEMPLATE_CHANNEL&#160;&#160;&#160;  template&lt;typename Blob_sender, typename Blob_receiver, typename Native_handle_sender, typename Native_handle_receiver&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>). </p>

<p class="definition">Definition at line <a class="el" href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html#l01344">1344</a> of file <a class="el" href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html">channel.hpp</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
